(#) androidx.annotation:annotation-experimental

Name
:   Experimental annotation
Description
:   Java annotation for use on unstable Android API surfaces. When used in
:   conjunction with the Experimental annotation lint checks, this
:   annotation provides functional parity with Kotlin's Experimental
:   annotation.
License
:   [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)
Vendor
:   Android Open Source Project
Identifier
:   androidx.annotation.experimental
Feedback
:   https://issuetracker.google.com/issues/new?component=459778
Min
:   Lint 8.0 and 8.1
Compiled
:   Lint 8.0 and 8.1
Artifact
:   androidx.annotation:annotation-experimental:1.5.0-alpha01

(##) Included Issues

|Issue Id                                                                  |Issue Description                                                       |
|--------------------------------------------------------------------------|------------------------------------------------------------------------|
|[UnsafeOptInUsageError](UnsafeOptInUsageError.md.html)                    |Unsafe opt-in usage intended to be error-level severity                 |
|[UnsafeOptInUsageWarning](UnsafeOptInUsageWarning.md.html)                |Unsafe opt-in usage intended to be warning-level severity               |
|[ExperimentalAnnotationRetention](ExperimentalAnnotationRetention.md.html)|Experimental annotation with incorrect retention                        |
|[WrongRequiresOptIn](WrongRequiresOptIn.md.html)                          |Experimental annotations defined in Kotlin must use kotlin.RequiresOptIn|

(##) Including

!!!
   This is not a built-in check. To include it, add the below dependency
   to your project.

```
// build.gradle.kts
implementation("androidx.annotation:annotation-experimental:1.5.0-alpha01")

// build.gradle
implementation 'androidx.annotation:annotation-experimental:1.5.0-alpha01'

// build.gradle.kts with version catalogs:
implementation(libs.annotation.experimental)

# libs.versions.toml
[versions]
annotation-experimental = "1.5.0-alpha01"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
annotation-experimental = {
    module = "androidx.annotation:annotation-experimental",
    version.ref = "annotation-experimental"
}
```

1.5.0-alpha01 is the version this documentation was generated from;
there may be newer versions available.

(##) Changes

* 1.0.0: First version includes UnsafeExperimentalUsageError,
  UnsafeExperimentalUsageWarning.
* 1.1.0: Adds UnsafeOptInUsageError, UnsafeOptInUsageWarning. Removes
  UnsafeExperimentalUsageError, UnsafeExperimentalUsageWarning.
* 1.2.0: Adds ExperimentalAnnotationRetention.
* 1.3.1: Adds WrongRequiresOptIn.

(##) Version Compatibility

There are multiple older versions available of this library:

| Version            | Date     | Issues | Compatible | Compiled      | Requires |
|-------------------:|----------|-------:|------------|--------------:|---------:|
|       1.5.0-alpha01|2024/08/21|       4|         Yes|    8.0 and 8.1|8.0 and 8.1|
|               1.4.1|2024/04/03|       4|         Yes|    8.0 and 8.1|8.0 and 8.1|
|               1.4.0|2024/01/24|       4|         Yes|    8.0 and 8.1|8.0 and 8.1|
|               1.3.1|2023/06/21|       4|         Yes|    7.3 and 7.4|       7.0|
|               1.3.0|2022/09/07|       3|         Yes|    7.3 and 7.4|       7.0|
|               1.2.0|2021/12/15|       3|      No[^1]|            7.1|       4.1|
|               1.1.0|2021/04/07|       2|         Yes|            4.1|       4.1|
|               1.0.0|2019/11/07|       2|         Yes|  Not specified|Not specified|

Compatibility Problems:

[^1]: com.android.tools.lint.client.api.AnnotationLookup#AnnotationLookup() is not available  

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>